home *** CD-ROM | disk | FTP | other *** search
/ Info-Mac 4 / Info_Mac IV CD-ROM (Pacific HiTech Inc.)(August 1994).iso / HyperCard / Script Optimizer 1.0.1 / About Script Optimizer 1.0.1 next >
Text File  |  1994-04-29  |  4KB  |  123 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6. About This Document
  7. -------------------
  8.  
  9. This document contains information on
  10.  
  11. • the Script Optimizer stack
  12. • changes since version 1.0
  13. • how to use Script Optimizer
  14. • freeware legal information 
  15. • contacting the author
  16.  
  17.  
  18. What is Script Optimizer?
  19. -------------------------
  20.  
  21. Script Optimizer 1.0.1 is a HyperCard stack that can analyze other stacks’ scripts and perform one to three optimizations on them:
  22.  
  23. • keyword abbreviation
  24. • comment removal
  25. • global checking
  26.  
  27. Keyword Abbreviation
  28.     HyperCard’s long-format keywords, such as “background” can 
  29.     be abbreviated to their shortest equivalent, such as “bg.” 
  30.     (Any keywords within quotation marks are left as-is.)
  31.  
  32. Comment Removal
  33.     Removes lines that begin with “--”, and ‘embedded comments’ 
  34.     within a line, such as “on mouse up -- Δ user stops”.
  35.     (Comment characters inside quotation marks are not removed.)
  36.  
  37. Global Checking
  38.     Often during the development cycle of a stack, some global 
  39.     variables remain within handlers, even though they are not 
  40.     used any longer. These unused globals can be removed. 
  41.     (Global variables that are declared within quotation marks 
  42.     are not checked.)
  43.  
  44.  
  45. Changes Since Version 1.0
  46. -------------------------
  47. • Script Optimizer optimizes "Can't Modify"-protected stacks;
  48. • Sample script display shows effects of each option;
  49. • Reports are more detailed;
  50. • Save and Report buttons have been removed (not needed);
  51. • Interface has been tidied up somewhat.
  52.  
  53.  
  54. How to Use Script Optimizer
  55. ---------------------------
  56.  
  57. Script Optimizer 1.0 requires HyperCard version 2.1 or later, and at least as much free disk space as the size of the stack to be optimized.
  58.  
  59. 1. Double-click the Script Optimizer stack to open it.
  60.  
  61. 2. Click Open… (or press the Return key).
  62.  
  63. 3. Select the stack you want to optimize.
  64.  
  65. 4. Select the optimizations you would like to perform.
  66.  
  67. 5. Select the scripts you want to perform the selected 
  68.    optimizations on.
  69.    To select or deselect all options, hold down the Option 
  70.    key as you click.
  71.  
  72. 6. Click Start.
  73.    A dialog box asks you to confirm that you have made a 
  74.    backup copy. Script Optimizer makes permanent changes 
  75.    to a stack. Be sure to only work on a backup copy of 
  76.    the stack (and test that it functions correctly after 
  77.    it has been optimized) before replacing the original.
  78.  
  79. Script Optimizer highlights the icon for the optimization it is currently performing, the icon for the script it is currently working on, and displays a progress bar.
  80.  
  81. To stop the optimization at any time, click the Stop button. After confirming your action, Script Optimizer will cancel any changes it has made so far, leaving the original stack intact. (At certain times, the Stop button is dimmed and the current process cannot be canceled.)
  82.  
  83. After completing the optimization(s) and saving the new scripts, Script Optimizer displays a brief summary of the changes that it has made.
  84.  
  85. To view a more detailed report, click the More… button. Script Optimizer displays a progress bar while it writes the report. To save this report to a text-only document, click the Save button that appears.
  86.  
  87.  
  88. Scripter’s Note
  89. ---------------
  90.  
  91. If you have use for this software, you’re probably quite likely to end up wanting to take it apart. A word of warning: Script Optimizer has been designed to work best in its original, *locked* state, so please tinker with an unlocked *copy* only.
  92.  
  93.  
  94. Legal Notice
  95. ------------
  96.  
  97. Naturally, I am not responsible in any way for any losses or damages resulting from your possession or use of this software. Please use this software exclusively at your own risk, and only ever use it on a backup copy of any stack.
  98.  
  99. This software is Freeware, but is not in the public domain. It remains the property of, and is Copyright © 1994 by Simon Poisson. All Rights Reserved. XFCNs: AbbrevLine, ListHandlers © Simon Poisson; StrWidth, FullReplace © Frédéric Rinaldi; SearchPlus © Jim Parshall.
  100.  
  101.  
  102. Simon Poisson
  103. -------------
  104. FirstClass E-Mail:
  105.     Khazad Dum BBS
  106.         61 2 834 4689
  107.     MacCity BBS
  108.         61 2 438 3711
  109.     MacInTouch BBS (preferred)
  110.         61 2 584 2522
  111.     Route 101 (AAPDA) BBS
  112.         61 2 975 4332
  113.  
  114. Snail Mail:
  115.     PO Box 256
  116.     Darlinghurst  NSW
  117.     Australia  2010
  118.  
  119.  
  120. Thank you for reading this document.
  121.  
  122.  
  123. Thursday, 28 April 1994